Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Alternative Schema Proposal #1868

Merged
merged 5 commits into from
Apr 25, 2019
Merged

Alternative Schema Proposal #1868

merged 5 commits into from
Apr 25, 2019

Conversation

cmheazel
Copy link
Contributor

This pull request proposes a directory structure for documenting enhancements to the OpenAPI specification. It is also populated with the markdown and supporting information for the Alternative Schema proposal.

cmheazel and others added 2 commits March 15, 2019 16:20
Re-sync with OpenAPI master
This commit contains the markup for the Alternative Schema Proposal and some supporting documention.  A directory structure is proposed so that the supporting data for a proposal is all in the same place.
@tedepstein
Copy link
Contributor

tedepstein commented Mar 30, 2019

@cmheazel and TSC (@darrelmiller, @earth2marsh, @MikeRalphson, @webron, @whitlockjc ...anyone else?)

I've been asked to move the discussion about inline alternative schemas from #1532 to a new issue. I can do that. But we're still somewhere in the process of implementing the new scheme to organize draft proposals and related issues, and I would much prefer to create this new issue within that framework, alongside other issues extracted from that same discussion thread.

I think we really need this new process so we can:

  • Raise issues large and small, popular and unpopular, without taking up precious space in a single comment thread on a single GitHub issue for a draft proposal.
  • Let people vote with their feet by weighing in on those issues or ignoring them.
  • Let people open pull requests against a baseline draft proposal.
  • Let the TSC do its job of triaging and prioritizing these issues and PRs, so other community members needn't worry that a suggested change is going to derail an important new feature.

I think we are all on board with these goals. Thanks @cmheazel for taking this up. I'd like to help build on this.

TSC folks, have you had a chance to review this PR? It would be great to have it soon, especially as we're getting into a higher-intensity review phase on these 3.1 draft proposals.

One more thing that would be really helpful: Create a designated GitHub label for each draft proposal. Apply that label to relevant issues and PRs. Specify that label towards the top of the draft proposal, followed by two links:

  1. Open issues related to the draft proposal (filtered by label)
  2. Open pull requests related to the draft proposal (filtered by label)

Updated the Alternative Schema proposal to follow the Apple SWIFT pattern.
Additional Cleanup to the Alternative Schema Proposal
@cmheazel
Copy link
Contributor Author

Updated to use the extension method for the Apple SWIFT-Evolution repository as discussed in the TSC meeting of 4/11/19

Moved proposal document up one level.
Added numeric pre-fixes to proposal files.
Per TSC meeting of April 18, 2019

|Name |Link |Description |
|--- | --- | --- |
|jsonSchema |TBD |JSON Schema | |xsdSchema |TBD |XML Schema |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems broken


Mixed OAS schema and alternative schema:

schema:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah ok so this is actually a thing. This really feels like it’s gonna throw a spanner in the works for inpmenebtors. Why can’t we keep them separate and just have JSON Schema define an array instead of mixing up OpenAPI Schema and other Schema?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants